Checkout3DSService

class Checkout3DSService @JvmOverloads() constructor(context: Context, environment: Environment, locale: Locale, uiCustomization: UICustomization?, appUrl: Uri?)

This is the main class of the SDK that performs payment authentication with the authenticate method. It only needs to be initialized once for the lifetime of the application, and is initialized with a set of constructor parameters.

Parameters

context

The app context. Required for Android to access application resources.

environment

The Checkout.com environment that the SDK will connect to. If no value is provided, the default is PRODUCTION.

  • SANDBOX enables you to test with Checkout.com’s systems without connecting to real card issuers or impacting real card holders.

  • PRODUCTION to process real transactions with real cards.

locale

The customer’s locale and preferred language, used to localise the user interface. If no value is set, the device locale is used. (E.g. Locale.UK)

uiCustomization

The customizations for the challenge user interface.

appUrl

A URL that can be used to open and move your app to the foreground.

This field is optional, but we recommend including it to ensure a smoother out-of-band challenge experience for your user. This way, the user is automatically redirected back to your app after their banking app has authorized the transaction. This feature is available if the user’s card issuer also supports it.

If your app uses a deep link scheme, make sure that this URL links to the current 3D Secure transaction or app page.

The appUrl field value can have up to 211 characters. If it exceeds 211 characters, it is ignored and the SDK returns an initialization warning.

Constructors

Checkout3DSService
Link copied to clipboard
fun Checkout3DSService(context: Context, environment: Environment = Environment.PRODUCTION, locale: Locale = Locale.getDefault(), uiCustomization: UICustomization? = null, appUrl: Uri? = null)

Types

Companion
Link copied to clipboard
object Companion

Functions

authenticate
Link copied to clipboard
fun authenticate(authenticationParameters: AuthenticationParameters, callback: AuthenticationCallback)
Method to start the authentication, passing the values you received in the Sessions API response into authenticationParameters.
getWarnings
Link copied to clipboard
fun getWarnings(): List<Warning>
Method to check for warnings of any potential security warnings or of rejected configuration requests.